/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flowable.cdi.impl.context;

import java.util.Map;

import org.flowable.common.engine.api.FlowableException;
import org.flowable.engine.runtime.Execution;
import org.flowable.task.api.Task;

/**
 * Represents a means for associating an execution with a context.
 * <p>
 * This enables the cdi logic to provide contextual business process management services, without relying on a specific context like i.e. the conversation context.
 * 
 * @author Daniel Meyer
 */
public interface ContextAssociationManager {

    /**
     * Disassociates the current process instance with a context / scope
     * 
     * @throws FlowableException
     *             if no process instance is currently associated
     */
    void disAssociate();

    /**
     * @return the id of the execution currently associated or null
     */
    String getExecutionId();

    /**
     * get the current execution
     */
    Execution getExecution();

    /**
     * associate with the provided execution
     */
    void setExecution(Execution execution);

    /**
     * set a current task
     */
    void setTask(Task task);

    /**
     * get the current task
     */
    Task getTask();

    /**
     * set a process variable
     */
    void setVariable(String variableName, Object value);

    /**
     * get a process variable
     */
    Object getVariable(String variableName);

    /**
     * @return a map of process variables cached between flushes
     */
    Map<String, Object> getCachedVariables();

}
